<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dfeprach: XDfePrach_NCO Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dfeprach
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_dfe_prach___n_c_o.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XDfePrach_NCO Struct Reference<div class="ingroups"><a class="el" href="group__dfeprach.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>NCO Config.  
 <a href="struct_x_dfe_prach___n_c_o.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a82e8d56b922b7a4d0e8fac2bdf702c42"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a82e8d56b922b7a4d0e8fac2bdf702c42">PhaseOffset</a></td></tr>
<tr class="memdesc:a82e8d56b922b7a4d0e8fac2bdf702c42"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">         [0-2^32-1] Phase offset value which can be
</pre><p> applied to the NCO's phase accumulator  <a href="#a82e8d56b922b7a4d0e8fac2bdf702c42">More...</a><br/></td></tr>
<tr class="separator:a82e8d56b922b7a4d0e8fac2bdf702c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e85da023c1c88ceb56ed748ae727e12"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a1e85da023c1c88ceb56ed748ae727e12">PhaseAcc</a></td></tr>
<tr class="memdesc:a1e85da023c1c88ceb56ed748ae727e12"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">       [0-2^32-1] Initial Phase accumulator value, used to
</pre><p> set the NCO phase accumualtor to a specific phase at startup  <a href="#a1e85da023c1c88ceb56ed748ae727e12">More...</a><br/></td></tr>
<tr class="separator:a1e85da023c1c88ceb56ed748ae727e12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafb16e37434841de906c93a9846b1090"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#aafb16e37434841de906c93a9846b1090">DualModCount</a></td></tr>
<tr class="memdesc:aafb16e37434841de906c93a9846b1090"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">           [0-2^32-1] The phase accumulator allows for dual
</pre><p> modulus accumulation to create fractional frequencies.  <a href="#aafb16e37434841de906c93a9846b1090">More...</a><br/></td></tr>
<tr class="separator:aafb16e37434841de906c93a9846b1090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc99e4741b7693489d6d6b5799de490"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a7dc99e4741b7693489d6d6b5799de490">DualModSel</a></td></tr>
<tr class="memdesc:a7dc99e4741b7693489d6d6b5799de490"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">         [0,1] Allows initialisation of the Dual mod select
</pre><p> to a known value  <a href="#a7dc99e4741b7693489d6d6b5799de490">More...</a><br/></td></tr>
<tr class="separator:a7dc99e4741b7693489d6d6b5799de490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a342fc87278e3f1fa9934f34bac18dd38"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a342fc87278e3f1fa9934f34bac18dd38">UserFreq</a></td></tr>
<tr class="memdesc:a342fc87278e3f1fa9934f34bac18dd38"><td class="mdescLeft">&#160;</td><td class="mdescRight">[-(2^23)-2^23] User defined frequency container  <a href="#a342fc87278e3f1fa9934f34bac18dd38">More...</a><br/></td></tr>
<tr class="separator:a342fc87278e3f1fa9934f34bac18dd38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a910685f45334111d31a24622e5699ce9"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a910685f45334111d31a24622e5699ce9">Frequency</a></td></tr>
<tr class="memdesc:a910685f45334111d31a24622e5699ce9"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0-2^32-1] Frequency control word (FCW)  <a href="#a910685f45334111d31a24622e5699ce9">More...</a><br/></td></tr>
<tr class="separator:a910685f45334111d31a24622e5699ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99a67084c1c62e2318e655d9bcb01a33"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a99a67084c1c62e2318e655d9bcb01a33">FreqSingleModCount</a></td></tr>
<tr class="memdesc:a99a67084c1c62e2318e655d9bcb01a33"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0-2^32-1] Single modulus cycle count (S)  <a href="#a99a67084c1c62e2318e655d9bcb01a33">More...</a><br/></td></tr>
<tr class="separator:a99a67084c1c62e2318e655d9bcb01a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad462ca5cbdca1cc04dd20864e1375c1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#aad462ca5cbdca1cc04dd20864e1375c1">FreqDualModCount</a></td></tr>
<tr class="memdesc:aad462ca5cbdca1cc04dd20864e1375c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0-2^32-1] Dual modulus cycle count (T-S)  <a href="#aad462ca5cbdca1cc04dd20864e1375c1">More...</a><br/></td></tr>
<tr class="separator:aad462ca5cbdca1cc04dd20864e1375c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190d32246497f3ba038346c963b93afe"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a190d32246497f3ba038346c963b93afe">FreqPhaseOffset</a></td></tr>
<tr class="memdesc:a190d32246497f3ba038346c963b93afe"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0-2^18-1] Phase offset  <a href="#a190d32246497f3ba038346c963b93afe">More...</a><br/></td></tr>
<tr class="separator:a190d32246497f3ba038346c963b93afe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a801e8496f7c43f2e6931277900899b77"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_prach___n_c_o.html#a801e8496f7c43f2e6931277900899b77">NcoGain</a></td></tr>
<tr class="memdesc:a801e8496f7c43f2e6931277900899b77"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">      [0-3] Scaling of NCO output (0=0dB, 1=-3dB,
</pre><p> 2=-6dB, 3=-9dB)  <a href="#a801e8496f7c43f2e6931277900899b77">More...</a><br/></td></tr>
<tr class="separator:a801e8496f7c43f2e6931277900899b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>NCO Config. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aafb16e37434841de906c93a9846b1090"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::DualModCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">           [0-2^32-1] The phase accumulator allows for dual
</pre><p> modulus accumulation to create fractional frequencies. </p>
<p>This field allows for initialisation of the dual mod count to a known value </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>, and <a class="el" href="group__dfeprach.html#gafe346328ed61f363a42a46f743b7a83d">XDfePrach_GetCapturePhase()</a>.</p>

</div>
</div>
<a class="anchor" id="a7dc99e4741b7693489d6d6b5799de490"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::DualModSel</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">         [0,1] Allows initialisation of the Dual mod select
</pre><p> to a known value </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>, and <a class="el" href="group__dfeprach.html#gafe346328ed61f363a42a46f743b7a83d">XDfePrach_GetCapturePhase()</a>.</p>

</div>
</div>
<a class="anchor" id="aad462ca5cbdca1cc04dd20864e1375c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::FreqDualModCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0-2^32-1] Dual modulus cycle count (T-S) </p>

</div>
</div>
<a class="anchor" id="a190d32246497f3ba038346c963b93afe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::FreqPhaseOffset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0-2^18-1] Phase offset </p>

</div>
</div>
<a class="anchor" id="a99a67084c1c62e2318e655d9bcb01a33"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::FreqSingleModCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0-2^32-1] Single modulus cycle count (S) </p>

</div>
</div>
<a class="anchor" id="a910685f45334111d31a24622e5699ce9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XDfePrach_NCO::Frequency</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0-2^32-1] Frequency control word (FCW) </p>

</div>
</div>
<a class="anchor" id="a801e8496f7c43f2e6931277900899b77"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::NcoGain</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">      [0-3] Scaling of NCO output (0=0dB, 1=-3dB,
</pre><p> 2=-6dB, 3=-9dB) </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, and <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a1e85da023c1c88ceb56ed748ae727e12"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::PhaseAcc</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">       [0-2^32-1] Initial Phase accumulator value, used to
</pre><p> set the NCO phase accumualtor to a specific phase at startup </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>, and <a class="el" href="group__dfeprach.html#gafe346328ed61f363a42a46f743b7a83d">XDfePrach_GetCapturePhase()</a>.</p>

</div>
</div>
<a class="anchor" id="a82e8d56b922b7a4d0e8fac2bdf702c42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfePrach_NCO::PhaseOffset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">         [0-2^32-1] Phase offset value which can be
</pre><p> applied to the NCO's phase accumulator </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, and <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a342fc87278e3f1fa9934f34bac18dd38"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XDfePrach_NCO::UserFreq</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[-(2^23)-2^23] User defined frequency container </p>

<p>Referenced by <a class="el" href="group___overview.html#ga1287a30b7e83158a48088593234ab1e4">XDfePrach_2CC3RCDynamicTestExample()</a>, <a class="el" href="group___overview.html#ga80c73e89a6fc66abac088bbc45431dc3">XDfePrach_2CC3RCReconfigureTestExample()</a>, and <a class="el" href="group___overview.html#gabd47bf94fdf2e70c66193ba7d36baded">XDfePrach_2CC3RCTestExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
